Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

1D Linearized Euler #1867

Merged
merged 20 commits into from
Apr 3, 2024
Merged

1D Linearized Euler #1867

merged 20 commits into from
Apr 3, 2024

Conversation

DanielDoehring
Copy link
Contributor

This adds the linearized Euler equations in 1D.
This comes with 3 examples: The usual convergence test, a somewhat nontrivial example with walls and an elixir that illustrates the computation of the analytical solution using the eigensystem.

@DanielDoehring DanielDoehring added the enhancement New feature or request label Mar 8, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Mar 8, 2024

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

  • The PR has a single goal that is clear from the PR title and/or description.
  • All code changes represent a single set of modifications that logically belong together.
  • No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

  • The code can be understood easily.
  • Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
  • There are no redundancies that can be removed by simple modularization/refactoring.
  • There are no leftover debug statements or commented code sections.
  • The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

  • New functions and types are documented with a docstring or top-level comment.
  • Relevant publications are referenced in docstrings (see example for formatting).
  • Inline comments are used to document longer or unusual code sections.
  • Comments describe intent ("why?") and not just functionality ("what?").
  • If the PR introduces a significant change or new feature, it is documented in NEWS.md.

Testing

  • The PR passes all tests.
  • New or modified lines of code are covered by tests.
  • New or modified tests run in less then 10 seconds.

Performance

  • There are no type instabilities or memory allocations in performance-critical parts.
  • If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

  • The correctness of the code was verified using appropriate tests.
  • If new equations/methods are added, a convergence test has been run and the results
    are posted in the PR.

Created with ❤️ by the Trixi.jl community.

@codecov Codecov
Copy link

codecov bot commented Mar 8, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 83.75000% with 13 lines in your changes are missing coverage. Please review.

Project coverage is 74.79%. Comparing base (641fde8) to head (10a2d72).

Files Patch % Lines
src/equations/linearized_euler_1d.jl 76.60% 11 Missing ⚠️
...em/elixir_linearizedeuler_characteristic_system.jl 93.10% 2 Missing ⚠️
Additional details and impacted files 
@@             Coverage Diff             @@
##             main    #1867       +/-   ##
===========================================
- Coverage   96.32%   74.79%   -21.54%     
===========================================
  Files         445      448        +3     
  Lines       35926    35947       +21     
===========================================
- Hits        34605    26883     -7722     
- Misses       1321     9064     +7743
Flag Coverage Δ
unittests 74.79% <83.75%> (-21.54%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

DanielDoehring
DanielDoehring commented Mar 9, 2024
View reviewed changes
src/equations/linearized_euler_1d.jl Outdated Show resolved Hide resolved
src/equations/linearized_euler_1d.jl Outdated Show resolved Hide resolved
src/equations/linearized_euler_1d.jl Outdated Show resolved Hide resolved
lchristm
lchristm reviewed Mar 12, 2024
View reviewed changes
Copy link
Member

@lchristm lchristm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this functionality! I left some comments but in my opinion there are no major issues.

examples/structured_1d_dgsem/elixir_linearizedeuler_characteristic_system.jl Outdated Show resolved Hide resolved
examples/structured_1d_dgsem/elixir_linearizedeuler_characteristic_system.jl Outdated Show resolved Hide resolved
examples/structured_1d_dgsem/elixir_linearizedeuler_characteristic_system.jl Outdated Show resolved Hide resolved
src/equations/linearized_euler_1d.jl Show resolved Hide resolved
@DanielDoehring
Copy link
Contributor Author

Thanks @lchristm for your review!

andrewwinters5000
andrewwinters5000 requested changes Mar 27, 2024
View reviewed changes
Copy link
Member

@andrewwinters5000 andrewwinters5000 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for extending this equation system to 1D! It is a nice addition, especially for teaching / tutorial purposes. I just left a few suggestions.

examples/structured_1d_dgsem/elixir_linearizedeuler_characteristic_system.jl Show resolved Hide resolved
examples/tree_1d_dgsem/elixir_linearizedeuler_gauss_wall.jl Outdated Show resolved Hide resolved
examples/tree_1d_dgsem/elixir_linearizedeuler_gauss_wall.jl Show resolved Hide resolved
test/test_tree_1d_linearizedeuler.jl Outdated Show resolved Hide resolved
src/equations/linearized_euler_1d.jl Outdated Show resolved Hide resolved
src/equations/linearized_euler_1d.jl Outdated Show resolved Hide resolved
src/equations/linearized_euler_1d.jl Show resolved Hide resolved
andrewwinters5000
andrewwinters5000 previously approved these changes Mar 29, 2024
View reviewed changes
Copy link
Member

@andrewwinters5000 andrewwinters5000 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@DanielDoehring DanielDoehring removed the request for review from sloede March 29, 2024 09:31
@DanielDoehring
Copy link
Contributor Author

Thanks @andrewwinters5000 for the review! The CI failures are solely due to codevov, so this should also be ready to merge.

@andrewwinters5000
Copy link
Member

@lchristm Are we good to merge?

@lchristm
Copy link
Member

lchristm commented Apr 2, 2024

@andrewwinters5000 Yes, looks good to me! Thanks again for adding this feature, @DanielDoehring

@andrewwinters5000
Copy link
Member

The only failures are from CodeCov strangeness, is it okay to merge this @sloede @ranocha ?

@ranocha
Copy link
Member

ranocha commented Apr 3, 2024

Yes. Thanks!

@ranocha ranocha merged commit b3bb457 into trixi-framework:main Apr 3, 2024
32 of 33 checks passed
@DanielDoehring DanielDoehring deleted the LinEuler1D branch April 3, 2024 11:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lchristm lchristm lchristm approved these changes

@andrewwinters5000 andrewwinters5000 andrewwinters5000 left review comments

Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@DanielDoehring @andrewwinters5000 @lchristm @ranocha